home *** CD-ROM | disk | FTP | other *** search
/ Aminet 22 / Aminet 22 (1997)(GTI - Schatztruhe)[!][Dec 1997].iso / Aminet / dev / c / HVC.lha / HVC.readme < prev   
Text File  |  1997-09-08  |  4KB  |  100 lines
  1. Short:    Small, simple and nice version/revision control system
  2. Author:   Rune Jacobsen «shitlips@fido.euroline.no»
  3. Uploader: Rune Jacobsen «shitlips@fido.euroline.no»
  4. Type:     dev/c
  5.  
  6.                            Henry Version Control v0.3
  7.                                        by
  8.                                   Rune Jacobsen
  9.  
  10. · Introduction
  11.  
  12. HVC was born out of need for a simple version control system for another project
  13. of  mine,  Henry  (which  you  may  have guessed). I have looked at a few of the
  14. others, and they didn't do exactly what I wanted, so I wrote my own. Turned  out
  15. to be a nice little exercise :)
  16.  
  17. · Why does it rule? (This section also doubles as documentation)
  18.  
  19. I doubt that it does, but it's dead  simple.  Everything  is  based  around  the
  20. magical  file  "HVC.h"  -  a header file this program automatically generates if
  21. there is no such file there already. If there is one there, it will read in  the
  22. Version,  Revision  and  Build numbers from this file, update the time info, and
  23. write it back. And if you give one or more of the arguments VER, REV or BUILD it
  24. will  bump them by one. Simple? Yes, I think so. Also, the output you get should
  25. be adequate for your version needs:
  26.  
  27. >--- Sample HVC.h file ---
  28.  
  29. /*
  30. ** Henry Version Control
  31. ** By Rune Jacobsen
  32. */
  33.  
  34. #define VERSION 0
  35. #define VERSTRING "0"
  36. #define REVISION 3
  37. #define REVSTRING "3"
  38. #define BUILD 15
  39. #define BUILDSTRING "15"
  40. #define TIMESTRING "19:39:33"
  41. #define DATESTRING "8/9-97"
  42.  
  43. /* EOF */
  44.  
  45. >--- Sample HVC.h file ---
  46.  
  47. The way I use it is that I have a "@HVC BUILD" thrown into my smakefile so  that
  48. every time I attempt to compile my project, the Build variable increases by one.
  49. Then, when I eventually decide that enough bugs have been  fixed  to  justify  a
  50. revision change, I do a "HVC REV" in a shell. I don't know about using the "VER"
  51. switch yet, as my project will probably stay at version 0 for quite a few months
  52. still. ;)
  53.  
  54. In my C program, I have a tiny little .c file that just uses  these  definitions
  55. to  build  up my version string etc. This little bugger is compiled every time I
  56. do a smake (just takes 1-2 seconds anyway), and then the whole  goob  is  linked
  57. into  the  final executable. Any other .o modules in my project that needs these
  58. values can of course get them as external variables, and  that  way  they  don't
  59. need  to  be recompiled. If there is such a thing as a God, I'm sure this is the
  60. way (s)he intended compilation and revision control to work. ;)
  61.  
  62. One thing to note is that the time string uses a 24 hour  clock,  and  the  date
  63. string  is in "european" form, i.e. DD/MM/YY. If this is a problem for you, mail
  64. me and bug me, and maybe I'll release a special one for you ;) Anyway,  this  is
  65. stuff  that  could easily be controlled by an env-variable, and I'll add that if
  66. there is any interest for it.
  67.  
  68. · How much does it cost?
  69.  
  70. Just a couple of bytes. HVC is Emailware, so if you use it (or  just  like  it),
  71. you  should  mail  me  (see  top  of  file)  and  tell  me  about it. Of course,
  72. suggestions etc. are welcome too.
  73.  
  74. If this program is ported to any Microsoft OS, I will of course have  to  charge
  75. anyone who uses it $50 - $100 and add a 1.2MB .DLL for keyfile checking, to keep
  76. with the tradition of that community.
  77.  
  78. · Revision history (Yeah, of course I had to include this, it's what it's all
  79.                     about, man! ;D)
  80.  
  81. v0.3 (8/9-97)
  82.  - Initial release to Aminet
  83.  - Wrote readme file
  84.  
  85. v0.2 (8/9-97)
  86.  - Added the time functions
  87.  
  88. v0.1 (7/9-97)
  89.  - Got the idea
  90.  - Added ReadArgs() parsing of arguments
  91.  - Added parsing of already existing HVC.h file
  92.  - Added writing back to file
  93.  
  94. · About the author
  95.  
  96. Hey, my name is Rune Jacobsen and I have a car. You can email me or visit me  on
  97. IRC.  I  am most often on Undernet #AmigaCafe (Shitlips is the nick), but I also
  98. have some guest appearances on ARCnet #IBeta (same nick).
  99.  
  100.